Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/add comments to faas inline helloworld samples #76

Merged
merged 3 commits into from
Feb 5, 2024
Merged

Feature/add comments to faas inline helloworld samples #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c3ab05
Added comments to function-inline-nodejs
ASEIDEL77 Dec 12, 2023
bf5c2bc
Added comments to __main__.py
ASEIDEL77 Dec 13, 2023
51590f9
Merge branch 'main' of github.com:ASEIDEL77/CodeEngine into feature/a…
ASEIDEL77 Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 89 additions & 11 deletions helloworld-samples/function-inline-nodejs/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,92 @@
// ======================================================= //
// IBM Cloud Code Engine - Functions-as-a-Service Sample //
// //
// main.js (NodeJS sample function) //
// //
// Returns a simple HTML response, containing a message //
// that renders a greeting text. If the `name` parameter //
// was used to invoke the function, the given value //
// will be used in the greeting. If no `name` parameter //
// was used, a static text will be rendered instead. //
// //
// This sample shows how to access URL parameters in a //
// function. //
// //
// To pass a name to the function, which will be used //
// to render a personalized greeting, invoke the function //
// with a parameter called 'name': //
// //
// <function url>?name=<your name> //
// //
// ======================================================= //

/**
* The `main` function is the entry-point into the function.
*
* A function can define multiple functions, but it needs to
* have one dedicated 'main' function, which will be called
* by the runtime.
*
* The 'main' function has one optional argument, which
* carries all the parameters the function was invoked with.
*
* Those arguments are dynamic and can change between
* function invocations.
*
* Additionally, a function has access to some
* predefined and also user-defined environment variables.
*
*/
function main(params) {
var msg = 'You did not tell me who you are.';
if (params.name) {
msg = `Hello, ${params.name}!`
} else {
msg = `Hello, Functions on CodeEngine!`
}
return {
headers: { 'Content-Type': 'text/html; charset=utf-8' },
body: `<html><body><h3>${msg}</h3></body></html>`
}

// the 'msg' variable carries our greeting text
let msg;

if (params.name) {
// if an argument with name 'name' was given during
// function invocation, build a greeting for the given
// name
msg = `Hello, ${params.name}!`
} else {
// if no argument with name 'name' was found, use
// a static greeting string instead
msg = `Hello, Functions on CodeEngine!`
}

// finally, build an HTML response that can be rendered
// properly in a browser. To do so, we need to specify
// the correct 'Content-Type' ('text/html' for HTML markup)
// Alternatively, we could also use 'text/plain' or
// 'application/json', depending on the text we plan to
// return.
return {
// specify headers for the HTTP response
// we only set the Content-Type in this case, to
// ensure the text is properly displayed in the browser
headers: {
'Content-Type': 'text/html; charset=utf-8'
},
// the body of the HTTP response carries the data, our
// function wants to return
// construct a very simple HTML page, which renders
// the greeting string, we constructed earlier as a
// level 3 header
body: `<html><body><h3>${msg}</h3></body></html>`
}
}

module.exports.main = main;
// export the main function within this source file
// as the 'main' symbol to make it known to the runtime
// This also works, if the function name is not 'main'.
// By exporting the function as 'main', it will be
// found and invoked by the runtime.
//
// Example:
// function my_main_func_with_another_name(params) {
// ...
// }
// ...
// // this also works!
// module.exports.main = my_main_func_with_another_name

module.exports.main = main;
75 changes: 74 additions & 1 deletion helloworld-samples/function-inline-python/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,87 @@
# ======================================================= #
# IBM Cloud Code Engine - Functions-as-a-Service Sample #
# #
# __main.py__ (Python sample function) #
# #
# Returns a simple HTML response, containing a message #
# that renders a greeting text. If the `name` parameter #
# was used to invoke the function, the given value #
# will be used in the greeting. If no `name` parameter #
# was used, a static text will be rendered instead. #
# #
# This sample shows how to access URL parameters in a #
# function. #
# #
# To pass a name to the function, which will be used #
# to render a personalized greeting, invoke the function #
# with a parameter called 'name': #
# #
# <function url>?name=<your name> #
# #
# ======================================================= #

##
# The `main` function is the entry-point into the function.
#
# A function can define multiple functions, but it needs to
# have one dedicated 'main' function, which will be called
# by the runtime.
#
# The 'main' function has one optional argument, which
# carries all the parameters the function was invoked with.
#
# Those arguments are dynamic and can change between
# function invocations.
#
# Additionally, a function has access to some
# predefined and also user-defined environment variables.
#

def main(params):
msg = 'You did not tell me who you are.'
if "name" in params:
# if an argument with name 'name' was given during
# function invocation, build a greeting for the given
# name
msg = f"Hello, {params['name']}!"
else:
# if no argument with name 'name' was found, use
# a static greeting string instead
msg = f"Hello, Functions on Code Engine!"

# finally, build an HTML response that can be rendered
# properly in a browser. To do so, we need to specify
# the correct 'Content-Type' ('text/html' for HTML markup)
# Alternatively, we could also use 'text/plain' or
# 'application/json', depending on the text we plan to
# return.
return {
# specify headers for the HTTP response
# we only set the Content-Type in this case, to
# ensure the text is properly displayed in the browser
"headers": {
'Content-Type': 'text/html; charset=utf-8',
},

# explicitly set the HTTP status code to 200
"statusCode": 200,

# the body of the HTTP response carries the data, our
# function wants to return
# construct a very simple HTML page, which renders
# the greeting string, we constructed earlier as a
# level 3 header
"body": f"<html><body><h3>{msg}</h3></body></html>",
}

# Optional:
# If you used a function name different from 'main', make
# the function known under the 'main' symbol to the
# runtime, so it can be invoked.
#
# Example:
#
# def my_main_func_with_another_name(params) {
# ...
# }
# ...
# main = my_main_func_with_another_name
Loading