dynamic sitemap

[amitu]

Status: Partially Done

Follow: #526
Code PR: #558
Doc PR: fastn-stack/fastn.com#88

TODO Tasks

• dynamic parameters for current and dependency packages
  • dynamic-urls in FPM.ftd, handling for foreign package
  • dynamic urls in sitemap #569
• default skip true for dynamic urls
  • skip header in dynamic-urls #567
• dynamic parameters for current package
  • Sitemap: Dynamic Parameters #558

Feature: web framework, sitemap.

https://www.youtube.com/watch?v=SdpCVTk84DM

https://www.fifthtry.com/fpm/~/20/

-- fpm.sitemap:

# Dynamic
skip: true

- user profile page with page:
  url: /<string:name>/<integer:page>/
  document: user-profile.ftd

- user profile page:
  url: /<string:name>/
  document: user-profile.ftd

If FPM sees a request to /amitu/1/ it will render user-profile.ftd document. And user-profile.ftd can use request-data processor to fetch data from URL etc.

[AbrarNitk]

Implementation Detail

• While parsing -- fpm.sitemap, store named parameter of url in package's sitemap. It will store type and the name of the parameter. We will use Map<String, String> Data Structure to store it.

[AbrarNitk]

Syntax Update

RegEx:

\<\s*([a-z]\w+)?\s*([a-z]\w+)\s*:([a-z]\w+)?\s*([a-z]\w+)\s*\>

Examples:

<string:username >/<integer:age>
< string : username >/< integer : age >
<optional string:username>/<integer:age>
<optional string : username>/< integer : age>
<optional string : username>/< optional integer : age>
< optional string : username >/< optional integer : age >

[AbrarNitk]

https://regexr.com/6vmrc

[AbrarNitk]

No longer supporting this. We are omitting optional because it will create more ambiguity.

[AbrarNitk]

Update

We are only supporting parameters without optional type.

Examples:

<string:username >/<integer:age>
< string : username >/< integer : age >

Regex:

\<\s*([a-z]\w+)\s*:\s*([a-z|A-Z|0-9|_]\w+)\s*\>

[AbrarNitk]

Note

If you are using custom path parameters in the URL, so defining the document key is mandatory. In the document key we are supporting path parameters. We are supporting it only in url key. url key is mapped with http request.

If we are writing like My Books: /books/<string:name>/ or url: /books/<string:name>/ this is an ingress request URL, because it going to map with the http request url.

Error Example

-- fpm.sitemap:

# Section: /
- My Books: /books/<string:name>/  ;; Error, because document key is not specified
- Python Books
  url: /python/<string:name>/ ;; Error, because document key is not specified
- My September Work: /work/september/
- My October Work
  url: /work/october/

Correct Example

-- fpm.sitemap:

# Section: /
- My Books: /books/<string:name>/
  document: /books/all/
- Python Book:
  url: /python/<string:name>/
  document: /books/python/
- My September Work: /work/september/
- My October Work
  url: /work/october/

[amitu]

@AbrarNitk Here the document should mention a ftd file name. Why the URL?

[AbrarNitk]

Both are working fine.

[AbrarNitk]

Cases 1

Requested URL: /person/arpita/28/, In this case document will be returned /person/arpita.ftd.

-- fpm.sitemap:

# Section: /
- Person: /person/<string:username>/<integer:age>/
  document: /person/arpita.ftd

# Section 2: /section2/
- Person: /person/<string:username>/foo/<integer:age>/
  document: /person/abrark.ftd

Case 2

Requested URL: /person/arpita/foo/28/, In this case document will be returned /person/abrark.ftd.

-- fpm.sitemap:

# Section: /
- Person: /person/<string:username>/<integer:age>/
  document: /person/arpita.ftd


# Section 2: /section2/
- Person: /person/<string:username>/foo/<integer:age>/
  document: /person/abrark.ftd

[amitu]

These examples are fine.

[AbrarNitk]

Testing

Status: Done

-- fpm.sitemap:

# Manager
url: /<string:username>/manager/<integer:age>/
document: person-manager.ftd

## Employee
url: /<string:username>/employee/<integer:age>/
document: person-employee.ftd


- Task1
  url: /<string:username>/task/<integer:age>/
  document: task-type-1.ftd

  - Task2
    url: /<string:username>/task2/<integer:age>/
    document: task-type-2.ftd

[amitu]

@AbrarNitk, lets add auto skip too. If the sitemap entry is dynamic, then skip=true should be assumed, as else it generates invalid URLs in header etc.