dynamic urls in sitemap

[AbrarNitk]

Status: Done

TODOs

• dynamic-urls in FPM.ftd, handling for current package
• dynamic-urls in FPM.ftd, handling for foreign package

Follow: #311

PR: Refactor
PR: Refactor
PR: Code
PR: Issue Fixed

dynamic-urls in sitemap:

It will only contain toc-items, It won't contain any section or subsection in it.

What parameters do we need in dynamic urls?

• url/id
• document
• readers
• writers
• path_parameters

-- fpm.package: b.com

-- fpm.dynamic-urls:

- Title Foo A: /foo-a/<string:user>
  document: personb.ftd
- Title Foo B
  url: /foo-b/<string:user>
  document: personb.ftd
- /foob/<string:user>
  document: personb.ftd

dynamic urls for dependencies

Package: b/FPM.ftd

-- fpm.package: b.com

-- fpm.dynamic-urls:

- /foob/<string:user>
  document: personb.ftd


-- fpm.sitemap:

- /foob/arpita/

Package: a/FPM.ftd

-- fpm.package: a.com

-- fpm.dependency: b.com
endpoint: http://127.0.0.1:8000
mount-point: /mount-b/


-- fpm.dynamic-urls:

- /foo/<string:user>
  document: person.ftd


-- fpm.sitemap:

- /foo/arpita/

- From B:
  url: /mount-b/foob/arpita/ (It is working)

Sitemap Lookup

• fpm lookup sequence logic
  • current package sitemap
  • current package dynamic sitemap
  • dependency ka dynamic sitemap(logic: based on mount point match prefix)
  • then dependencies proxy pass to endpoint/backend(logic: only with mount point match prefix)
  • else 404

Assuming fpm is serving package a.com.

Case 1: Request for Current Package ftd Document

If the request comes for /foo/arpita/, fpm will look up the current package sitemap and serve it.

Case 2: Request with dynamic parameters for Current Package

If the request comes for /foo/abrark/, fpm will look up sitemap it will not be matched, then it will look up in fpm.dynamic-urls and it will be matched and return person.ftd file.

Case 3: Request for dependency package ftd Document

If the request comes for a.com/-/kameri-app/ so fpm will redirect it to a.com/todos/, or if the request comes for a.com/-/kameri-app/add-todo/ so fpm will redirect it to a.com/todos/add-todo/.

If the request comes for a.com/todos/ so in that case /kameri-app/index.ftd file should be served. If the request comes for a.com/todos/add-todo/ so in that case /kameri-app/add-todo.ftd will be served.

kameri-app
  - add-todo.ftd
  - index.ftd

-- fpm.package: a.com

-- fpm.dependency: kameri-app
endpoint: http://kameri-service.com/
mount-point: /todos/

-- fpm.sitemap:

- todo page: /todos/
- Add todo page: /todos/add-todo/

Case 4: Request for dynamic URL for dependency package

if a request comes for a.com/mount-b/foob/abrark/.

• fpm will look up into current package sitemap, not found.
• fpm will look up the current package dynamic-urls, not found.
• fpm will look up dependencies and prefix mount-b will be mactched with b's mount-point, So it will look up dynamic-urls of package b. So /mount-b/foob/abrark/ will be mapped to /foob/<string:user> and personb.ftd will returned.

---

kameri

• add-todo.ftd
• index.ftd

abrark/FPM.ftd

If a request comes for ftd file for a dependency package like /todos/add-todo/, this mapping should be present in the current package sitemap.

api call: /todos/api/add-todo/ redirect to /todos/
In that case, mount-point should be passed to kameri-service in request header X-FPM-MOUNT-POINT

-- fpm.dependency: kameri-app
endpoint: http://kameri-service.com/
mount-point: /todos/

-- fpm.sitemap:

- todo page: /todos/
- Add todo page: /todos/add-todo/

[AbrarNitk]

Implementation Details

Type fpm.dynamic-url in FPM.ftd file

Case 1: This way we don't have to parse the body.

-- record dynamic-url-data:
string url:
string document:
string list readers:
string list writers:

-- record dynamic-urls-data:
dynamic-url list dynamic-url-data:

-- optional dynamic-urls-data dynamic-urls:

Case 2: This way we don't have to parse the body

-- record dynamic-urls-rec:
body dynamic-urls-body:


-- optional dynamic-urls-rec dynamic-urls:

Sample File:

-- fpm.dynamic-urls:

# Dynamic Urls Section

- Url 1
  url: /person/<string:name>/
  document: person.ftd
  readers: readers/person
  writers: writers/person
- Url 2
  url: /person/<string:name>/
  document: person.ftd
  readers: readers/person
  writers: writers/person