aws_lambda_ric 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7531514e0f2ab9ba840cdcd973a36cadb45e9887db24a7fa0337e6eaca16e8a
-  data.tar.gz: b1be16c96fdc08b4651e99a4eb20f17ca3af69dee48476e58b075b910863a72d
+  metadata.gz: 0f2523ec3d2acb227fa11e42ec19db8e6cfed477fd3fe696437e15ad403290c9
+  data.tar.gz: ada075ea78b2b5004ba1afae30a176621a7fb721d897911450916cd0605c02ad
 SHA512:
-  metadata.gz: 7a9d932188a665f2865a71c9e7d06a6864fd7728925589e587c3ef71926c20ae0345cb9b7879c7457f586f7956df3ec41260038464ef34d50af6a785c81cfd71
-  data.tar.gz: 2b00da39020716fda73d50954e74ec76013a2aa0548c363411d743c03e01b888ff59a123921cf8915bef617cae0ebde7a35743588a589ca56edb5649fb88a956
+  metadata.gz: a30b399adaafe4a614e8cbe4ebfebbec435fbeafe9be10e87033e6555a3b9dccb6ccaa2ac1d2a4ee1f909a067b9a1bf350317bb6e397786ee39ce44fa543926c
+  data.tar.gz: 9e2deffd3a8ad44bb62a5d9b66a8c3cf8b01ca70e3dd2a4898be35946cc69bef334e4e172d10d163c94194b54277fe7a2b7c0644364250848b6d83d6e09c7a92

data/README.md

@@ -1,22 +1,23 @@
 ## AWS Lambda Ruby Runtime Interface Client
 
-We have open-sourced a set of software packages, Runtime Interface Clients (RIC), that implement the Lambda
- [Runtime API](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-api.html), allowing you to seamlessly extend your preferred
-  base images to be Lambda compatible.
-The Lambda Runtime Interface Client is a lightweight interface that allows your runtime to receive requests from and send requests to the Lambda service.
+We have open-sourced a set of software packages, Runtime Interface Clients (RIC), that implements the Lambda
+[Runtime API](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-api.html), allowing you to seamlessly extend
+your preferred base images to be Lambda compatible.
+The Lambda Runtime Interface Client is a lightweight interface that allows your runtime to
+receive requests from and send requests to the Lambda service.
 
 The Lambda Ruby Runtime Interface Client is vended through [rubygems](https://rubygems.org/gems/aws_lambda_ric). 
 You can include this package in your preferred base image to make that base image Lambda compatible.
 
 ## Requirements
-The Ruby Runtime Interface Client package currently supports Ruby versions:
- - 2.5.x up to and including 2.7.x
+The Ruby Runtime Interface Client package currently supports ruby 3.0 and above.
  
 ## Usage
 
 ### Creating a Docker Image for Lambda with the Runtime Interface Client
 First step is to choose the base image to be used. The supported Linux OS distributions are:
 
+ - Amazon Linux 2023
  - Amazon Linux 2
  - Alpine
  - Debian
@@ -36,17 +37,9 @@ Or install it manually as:
 
     $ gem install aws_lambda_ric
 
-
-Next step would be to copy your Lambda function code into the image's working directory.
-```dockerfile
-# Copy function code
-RUN mkdir -p ${FUNCTION_DIR}
-COPY app.rb ${FUNCTION_DIR}
-
-WORKDIR ${FUNCTION_DIR}
-```
-
-The next step would be to set the `ENTRYPOINT` property of the Docker image to invoke the Runtime Interface Client and then set the `CMD` argument to specify the desired handler.
+The next step would be to copy your Lambda function code into the image's working directory.
+You will need to set the `ENTRYPOINT` property of the Docker image to invoke the Runtime Interface Client and
+then set the `CMD` argument to specify the desired handler.
 
 Example Dockerfile:
 ```dockerfile
@@ -56,7 +49,7 @@ FROM amazonlinux:latest
 ARG FUNCTION_DIR="/function"
 
 # Install ruby
-RUN amazon-linux-extras install -y ruby2.6
+RUN dnf install -y ruby3.2 make
 
 # Install bundler
 RUN gem install bundler
@@ -64,6 +57,15 @@ RUN gem install bundler
 # Install the Runtime Interface Client
 RUN gem install aws_lambda_ric
 
+# If you want to install Runtime Interface Client From Source, you can uncomment the following `ADD` and `RUN` layers. 
+# Do not forget to comment/remove the above `RUN gem install aws_lambda_ric` command.
+# ADD https://github.com/aws/aws-lambda-ruby-runtime-interface-client.git /aws_lambda_ric
+# RUN cd /aws_lambda_ric && \
+#     make init && \
+#     make build && \
+#     gem install --local /aws_lambda_ric/pkg/aws_lambda_ric-3.0.0.gem && \
+#     rm -rf /aws_lambda_ric
+
 # Copy function code
 RUN mkdir -p ${FUNCTION_DIR}
 COPY app.rb ${FUNCTION_DIR}
@@ -74,7 +76,18 @@ ENTRYPOINT ["/usr/local/bin/aws_lambda_ric"]
 CMD ["app.App::Handler.process"]
 ```
 
-Example Ruby handler `app.rb`:
+Note that the `ENTRYPOINT` may differ based on the base image used. You can find the correct path by running an
+interactive shell in the container and checking the installed location of the gem.
+
+```shell script
+docker run -it --rm amazonlinux:latest bash
+yum install -y which ruby
+gem install aws_lambda_ric
+which aws_lambda_ric
+```
+
+Finally, create a Ruby handler. This is an example `app.rb`:
+
 ```ruby
 module App
   class Handler
@@ -87,7 +100,10 @@ end
 
 ### Local Testing
 
-To make it easy to locally test Lambda functions packaged as container images we open-sourced a lightweight web-server, Lambda Runtime Interface Emulator (RIE), which allows your function packaged as a container image to accept HTTP requests. You can install the [AWS Lambda Runtime Interface Emulator](https://github.com/aws/aws-lambda-runtime-interface-emulator) on your local machine to test your function. Then when you run the image function, you set the entrypoint to be the emulator. 
+To make it easy to locally test Lambda functions packaged as container images we open-sourced a lightweight web-server,
+Lambda Runtime Interface Emulator (RIE), which allows your function packaged as a container image to accept HTTP requests.
+You can install the [AWS Lambda Runtime Interface Emulator](https://github.com/aws/aws-lambda-runtime-interface-emulator) on your local machine to test your function.
+Thenm when you run the image function, you set the entrypoint to be the emulator. 
 
 *To install the emulator and test your Lambda function*
 
@@ -98,7 +114,8 @@ mkdir -p ~/.aws-lambda-rie && \
     curl -Lo ~/.aws-lambda-rie/aws-lambda-rie https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie && \
     chmod +x ~/.aws-lambda-rie/aws-lambda-rie
 ```
-2) Run your Lambda image function using the docker run command. 
+
+1) Run your Lambda image function using the docker run command. 
 
 ```shell script
 docker run -d -v ~/.aws-lambda-rie:/aws-lambda -p 9000:8080 \
@@ -109,7 +126,7 @@ docker run -d -v ~/.aws-lambda-rie:/aws-lambda -p 9000:8080 \
 
 This runs the image as a container and starts up an endpoint locally at `http://localhost:9000/2015-03-31/functions/function/invocations`. 
 
-3) Post an event to the following endpoint using a curl command: 
+1) Post an event to the following endpoint using a curl command: 
 
 ```shell script
 curl -XPOST "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{}'

data/lib/aws_lambda_ric/lambda_context.rb

@@ -3,7 +3,7 @@
 class LambdaContext
   attr_reader :aws_request_id, :invoked_function_arn, :log_group_name,
               :log_stream_name, :function_name, :memory_limit_in_mb, :function_version,
-              :identity, :client_context, :deadline_ms
+              :identity, :tenant_id, :client_context, :deadline_ms
 
   def initialize(request)
     @clock_diff = Process.clock_gettime(Process::CLOCK_REALTIME, :millisecond) - Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)
@@ -16,6 +16,7 @@ class LambdaContext
     @memory_limit_in_mb = ENV['AWS_LAMBDA_FUNCTION_MEMORY_SIZE']
     @function_version = ENV['AWS_LAMBDA_FUNCTION_VERSION']
     @identity = JSON.parse(request['Lambda-Runtime-Cognito-Identity']) unless request['Lambda-Runtime-Cognito-Identity'].to_s.empty?
+    @tenant_id = request['Lambda-Runtime-Aws-Tenant-Id'] unless request['Lambda-Runtime-Aws-Tenant-Id'].to_s.empty?
     @client_context = JSON.parse(request['Lambda-Runtime-Client-Context']) unless request['Lambda-Runtime-Client-Context'].to_s.empty?
   end
 

data/lib/aws_lambda_ric/logger_patch.rb

@@ -4,19 +4,15 @@ module LoggerPatch
   def initialize(logdev, shift_age = 0, shift_size = 1048576, level: 'debug',
                  progname: nil, formatter: nil, datetime_format: nil,
                  binmode: false, shift_period_suffix: '%Y%m%d')
-    #  use unpatched constructor if logdev is a filename or an IO Object other than $stdout or $stderr
-    if logdev && logdev != $stdout && logdev != $stderr
-      super(logdev, shift_age, shift_size, level: level, progname: progname,
-            formatter: formatter, datetime_format: datetime_format,
-            binmode: binmode, shift_period_suffix: shift_period_suffix)
-    else
-      self.level = level
-      self.progname = progname
+    logdev_lambda_overwrite = logdev
+    # use unpatched constructor if logdev is a filename or an IO Object other than $stdout or $stderr
+    if !logdev || logdev == $stdout || logdev == $stderr
+      logdev_lambda_overwrite = AwsLambdaRIC::TelemetryLogger.telemetry_log_sink
       @default_formatter = LogFormatter.new
-      self.datetime_format = datetime_format
-      self.formatter = formatter
-      @logdev = AwsLambdaRIC::TelemetryLogger.telemetry_log_sink
-      @level_override = {}
     end
+
+    super(logdev_lambda_overwrite, shift_age, shift_size, level: level, progname: progname,
+                                    formatter: formatter, datetime_format: datetime_format,
+                                    binmode: binmode, shift_period_suffix: shift_period_suffix)
   end
 end

data/lib/aws_lambda_ric/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AwsLambdaRIC
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws_lambda_ric
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - AWS Lambda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 2025-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler