edeliver_fork

v1.4.6

edeliver_fork

edeliver_fork v1.4.6 Edeliver.Relup.Instructions.RerunFailedRequests

Runs phoenix requests again which failed during hot code upgrade.

This upgrade instruction notifies request processes which were handling requests while new code was loaded that they can be rerun if they failed during the upgrade. It is required that a phoenix version is used which supports the upgrade notification feature. This instruction should be used in conjunction with and after the

Edeliver.Relup.Instructions.FinishRunningRequests

instruction which notifies the request processes that the code upgrade is started.

To make sure that the http request connections can be found on the node, use this instruction after the

Edeliver.Relup.Instructions.CheckRanchConnections

instruction which will abort the upgrade if the http request connections accepted by ranch cannot be found in the supervision tree.

Link to this section Summary

Functions

arguments(instructions, config)

Returns name of the application. This name is taken as argument for the run/1 function and is required to access the acceptor processes through the supervision tree

call_this(arguments \\ [])

Calls the run/1 function of this module

dependencies()

This module depends on the Edeliver.Relup.Instructions.CheckRanchAcceptors, the Edeliver.Relup.Instructions.CheckRanchConnections and the Edeliver.Relup.Instructions.FinishRunningRequests module which must be loaded before this instruction for upgrades and unload after this instruction for downgrades

insert_where()

Returns a function which inserts the relup instruction

modify_relup(instructions, config)

Modifies the relup file

run(otp_application_name)

Notifies request processes which handled http requests during the release upgrade / downgrade that the code loading is finished and that requests that failed during the code loading can be now rerun with the updated code

Link to this section Functions

Link to this function arguments(instructions, config) 
arguments(
  %Edeliver.Relup.Instructions{
    changed_modules: term(),
    down_instructions: term(),
    down_version: term(),
    up_instructions: term(),
    up_version: term()
  },
  Edeliver.Relup.Config.t()
) :: term()

Returns name of the application. This name is taken as argument for the run/1 function and is required to access the acceptor processes through the supervision tree

Link to this function call_this(arguments \\ []) 
call_this(arguments :: [term()]) ::
  Instruction.instruction() | Instruction.instructions()

Calls the run/1 function of this module

from the relup file during hot code upgrade

Link to this function dependencies() 
dependencies() :: [instruction_module :: atom()]
dependencies() :: [Edeliver.Relup.Instructions.CheckRanchAcceptors]

This module depends on the Edeliver.Relup.Instructions.CheckRanchAcceptors, the Edeliver.Relup.Instructions.CheckRanchConnections and the Edeliver.Relup.Instructions.FinishRunningRequests module which must be loaded before this instruction for upgrades and unload after this instruction for downgrades.

Link to this function insert_where() 
insert_where() :: Instruction.insert_fun()

Returns a function which inserts the relup instruction

that calls the Edeliver.Relup.RunnableInstruction.run/1 fuction of this module. Default is inserting it at the end of the instructions

Callback implementation for Edeliver.Relup.RunnableInstruction.insert_where/0.

Link to this function modify_relup(instructions, config)

Modifies the relup file.

Modifies the relup file which will be used to upgrade (or downgrade) from one version to another by inserting, removing, or shifting appup instructions. See Edeliver.Relup.InsertInstruction and Edeliver.Relup.ShiftInstruction for useful helpers to insert / position the instructions and Edeliver.Relup.RunnableInstruction to execute custom code during the upgrade.

Callback implementation for Edeliver.Relup.Instruction.modify_relup/2.

Link to this function run(otp_application_name) 
run(otp_application_name :: atom()) :: :ok

Notifies request processes which handled http requests during the release upgrade / downgrade that the code loading is finished and that requests that failed during the code loading can be now rerun with the updated code.